Simplify/unify XMPP element metrics #4520
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment was marked as outdated.
This comment was marked as outdated.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4520 +/- ##
==========================================
+ Coverage 85.86% 85.88% +0.01%
==========================================
Files 565 565
Lines 33803 33795 -8
==========================================
- Hits 29025 29024 -1
+ Misses 4778 4771 -7 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
chrzaszcz
force-pushed
the
simplify-element-metrics
branch
from
9923835 to
84d7d06
Compare
This comment was marked as outdated.
This comment was marked as outdated.
chrzaszcz
force-pushed
the
simplify-element-metrics
branch
from
84d7d06 to
9d1a993
Compare
This comment was marked as outdated.
This comment was marked as outdated.
chrzaszcz
force-pushed
the
simplify-element-metrics
branch
from
9d1a993 to
4540c4f
Compare
This comment was marked as outdated.
This comment was marked as outdated.
chrzaszcz
force-pushed
the
simplify-element-metrics
branch
from
4540c4f to
f39f613
Compare
This comment was marked as outdated.
This comment was marked as outdated.
chrzaszcz
force-pushed
the
simplify-element-metrics
branch
from
f39f613 to
262ddac
Compare
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
The new module has two functions:
- execute_element_event/5 for incoming/outgoing XML elements
- instrumentation/1 for declaration of events for elements and data
Element events are simplified to xmpp_element_in/out with the following labels:
- connection_type: c2s, s2s or component
- host_type: it can be an empty binary if no host type is known,
e.g. for components, or for stream start errors.
* for exometer, empty host type is translated to 'global';
* prometheus treats empty string as no label, so no translation is needed.
Host type is always undefined for components.
It is now easier to collect all XMPP metrics (not only c2s), and the total traffic is a better estimation of system load, e.g. someone might only use components, and no c2s.
Also, refactor helpers to be more concise.
There is need to check for the empty host type in the labels, because components don't have host types assigned to them.
Replace 'global' with host type when necessary. This is needed, because all XML elements are reported per host type if the host type is known.
chrzaszcz
force-pushed
the
simplify-element-metrics
branch
from
7da5aab to
a631cef
Compare
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
chrzaszcz
force-pushed
the
simplify-element-metrics
branch
from
12263f0 to
e42b247
Compare
This comment was marked as outdated.
This comment was marked as outdated.
chrzaszcz
force-pushed
the
simplify-element-metrics
branch
from
e42b247 to
ffdaf05
Compare
Actually, only one event was tested, because the 3-element tuples were filtered out. xx
chrzaszcz
force-pushed
the
simplify-element-metrics
branch
from
ffdaf05 to
6a9bcf6
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Affected metrics: - xmpp_element_size_in and xmpp_element_out, which replaced the 'element' and 'size' metrics. - c2s_auth_failed, s2s_auth_failed, component_auth_failed Other changes in the docs: - Dropped distintion between host-type-specific and global metrics, because it was difficult to group metrics by functionality, and most metrics were decribed with labels anyway. - Merged descriptions of data metrics (tcp_data_in, tcp_data_out, tls_data_in, tls_data_out) for improved consistency and reduced verbosity. - Added a new column with labels where labels differ between rows.
chrzaszcz
force-pushed
the
simplify-element-metrics
branch
from
c260d7d to
6134f1d
Compare
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
|
elasticsearch_and_cassandra_27 / elasticsearch_and_cassandra_mnesia / 6134f1d small_tests_26 / small_tests / 6134f1d small_tests_27 / small_tests / 6134f1d small_tests_27_arm64 / small_tests / 6134f1d ldap_mnesia_26 / ldap_mnesia / 6134f1d ldap_mnesia_27 / ldap_mnesia / 6134f1d dynamic_domains_pgsql_mnesia_27 / pgsql_mnesia / 6134f1d dynamic_domains_mysql_redis_27 / mysql_redis / 6134f1d dynamic_domains_pgsql_mnesia_26 / pgsql_mnesia / 6134f1d dynamic_domains_mssql_mnesia_27 / odbc_mssql_mnesia / 6134f1d pgsql_cets_27 / pgsql_cets / 6134f1d mysql_redis_27 / mysql_redis / 6134f1d pgsql_mnesia_27 / pgsql_mnesia / 6134f1d pgsql_mnesia_26 / pgsql_mnesia / 6134f1d cockroachdb_cets_27 / cockroachdb_cets / 6134f1d pubsub_SUITE:dag+last_item_cache:send_last_published_item_no_items_test{error,
{timeout_when_waiting_for_stanza,
[{escalus_client,wait_for_stanza,
[{client,
<<"alice_send_last_published_item_no_items_test_3749@localhost/res1">>,
escalus_tcp,<0.118002.0>,
[{event_manager,<0.117983.0>},
{server,<<"localhost">>},
{username,
<<"alicE_send_last_published_item_no_items_test_3749">>},
{resource,<<"res1">>}],
[{event_client,
[{event_manager,<0.117983.0>},
{server,<<"localhost">>},
{username,
<<"alicE_send_last_published_item_no_items_test_3749">>},
{resource,<<"res1">>}]},
{resource,<<"res1">>},
{username,
<<"alice_send_last_published_item_no_items_test_3749">>},
{server,<<"localhost">>},
{host,<<"localhost">>},
{port,5222},
{auth,fun escalus_auth:auth_plain/2},
{wspath,undefined},
{username,
<<"alicE_send_last_published_item_no_items_test_3749">>},
{server,<<"localhost">>},
{password,<<"matygrysa">>},
{stream_id,<<"901c37e7dcc3699b">>}]},
5000],
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
{line,136}]},
{pubsub_tools,receive_response,3,
[{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
{line,434}]},
{pubsub_tools,receive_and_c...pubsub_SUITE:dag+last_item_cache:send_last_published_item_no_items_test{error,
{timeout_when_waiting_for_stanza,
[{escalus_client,wait_for_stanza,
[{client,
<<"alice_send_last_published_item_no_items_test_3754@localhost/res1">>,
escalus_tcp,<0.118081.0>,
[{event_manager,<0.118069.0>},
{server,<<"localhost">>},
{username,
<<"alicE_send_last_published_item_no_items_test_3754">>},
{resource,<<"res1">>}],
[{event_client,
[{event_manager,<0.118069.0>},
{server,<<"localhost">>},
{username,
<<"alicE_send_last_published_item_no_items_test_3754">>},
{resource,<<"res1">>}]},
{resource,<<"res1">>},
{username,
<<"alice_send_last_published_item_no_items_test_3754">>},
{server,<<"localhost">>},
{host,<<"localhost">>},
{port,5222},
{auth,fun escalus_auth:auth_plain/2},
{wspath,undefined},
{username,
<<"alicE_send_last_published_item_no_items_test_3754">>},
{server,<<"localhost">>},
{password,<<"matygrysa">>},
{stream_id,<<"dfee566c7a916ba4">>}]},
5000],
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
{line,136}]},
{pubsub_tools,receive_response,3,
[{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
{line,434}]},
{pubsub_tools,receive_and_c...pubsub_SUITE:dag+last_item_cache:send_last_published_item_no_items_test{error,
{timeout_when_waiting_for_stanza,
[{escalus_client,wait_for_stanza,
[{client,
<<"alice_send_last_published_item_no_items_test_3756@localhost/res1">>,
escalus_tcp,<0.118158.0>,
[{event_manager,<0.118146.0>},
{server,<<"localhost">>},
{username,
<<"alicE_send_last_published_item_no_items_test_3756">>},
{resource,<<"res1">>}],
[{event_client,
[{event_manager,<0.118146.0>},
{server,<<"localhost">>},
{username,
<<"alicE_send_last_published_item_no_items_test_3756">>},
{resource,<<"res1">>}]},
{resource,<<"res1">>},
{username,
<<"alice_send_last_published_item_no_items_test_3756">>},
{server,<<"localhost">>},
{host,<<"localhost">>},
{port,5222},
{auth,fun escalus_auth:auth_plain/2},
{wspath,undefined},
{username,
<<"alicE_send_last_published_item_no_items_test_3756">>},
{server,<<"localhost">>},
{password,<<"matygrysa">>},
{stream_id,<<"137e3369f3f6b13a">>}]},
5000],
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
{line,136}]},
{pubsub_tools,receive_response,3,
[{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
{line,434}]},
{pubsub_tools,receive_and_c...mssql_mnesia_27 / odbc_mssql_mnesia / 6134f1d |
chrzaszcz
changed the title
NelsonVides
approved these changes
Apr 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The main goal is to simplify and unify events for XMPP (XML) elements. The main benefit is that unified metrics become easier to understand, maintain, test and document.
Before, there would be pairs of events like
c2s_element_inandxmpp_element_size_in. After, there is only one event:xmpp_element_in. The complete list is shown below:c2s_element_in(labels:host_type) andxmpp_element_size_in(labels:connection_type=c2s) are merged toxmpp_element_in(labels:host_type,connection_type=c2s).c2s_element_out(labels:host_type) andxmpp_element_size_out(labels:connection_type=c2s) are merged toxmpp_element_out(labels:host_type,connection_type=c2s).s2s_element_inandxmpp_element_size_in(labels:connection_type=s2s) are merged toxmpp_element_in(labels:host_type,connection_type=s2s).s2s_element_outandxmpp_element_size_out(labels:connection_type=s2s) are merged toxmpp_element_out(labels:host_type,connection_type=s2s).component_element_inandxmpp_element_size_in(labels:connection_type=component) are merged toxmpp_element_in(labels:host_type="",connection_type=component).component_element_outandxmpp_element_size_out(labels:connection_type=component) are merged toxmpp_element_out(labels:host_type="",connection_type=component).Notes:
c2s_element_*were missing if host type was unknown (e.g. in case of early stream errors). Now it is no longer the case.globalas the prefix in such cases.